<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: util/native_handle.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_a762a7cb84c76c9561dbc78c61068184.html">util</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">native_handle.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="native__handle_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Core</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &lt;ostream&gt;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &lt;flow/common.hpp&gt;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1util.html">ipc::util</a></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span>{</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="preprocessor">#ifndef FLOW_OS_LINUX</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="keyword">static_assert</span>(<span class="keyword">false</span>, <span class="stringliteral">&quot;Flow-IPC supports transmitting native handles in Linux only; a core feature.  &quot;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>                       <span class="stringliteral">&quot;Build in Linux only.&quot;</span>);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment">// From this point on (in #including .cpp files as well) POSIX is assumed; and in a few spots specifically Linux.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment">/* Note: We lack a native_handle_fwd.hpp, as it&#39;s such a thin wrapper around an FD (int) that there&#39;s no point</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * forward-declaring it, as it&#39;s ~always referred to by value. */</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"></span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment">/**</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> * A monolayer-thin wrapper around a native handle, a/k/a descriptor a/k/a FD.</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * It would have been acceptable to simply use an alias</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * to the native handle type (in POSIX, `int`), but this way is better stylistically with exactly zero performance</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> * overhead.  Initialize it, e.g., `Native_handle hndl(some_fd);`, where</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * `some_fd` might be some POSIX-y FD (network socket, Unix domain socket, file descriptor, etc.).</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> * Or initialize via no-arg construction which results in an `null() == true` object.  Copy construction, assignment,</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> * equality, total ordering, and hashing all work as one would expect and essentially the same as on the underlying</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> * native handles.</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> *</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> * It is either null() or stores a native handle.  In the former case, null() being `true` means explicitly</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> * that `m_native_handle == Native_handle::S_NULL_HANDLE`.</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> *</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> * ### Rationale ###</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> * Originally we tried to make it aggregate-initializable, like `Native_handle hndl = {some_fd}`; for example see</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * standard `array&lt;&gt;`.  This is reassuring perf-wise; and it involves less (i.e., no) code to boot.</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> * However, it really is just one light-weight scalar, and there&#39;s 0% chance explicit construction is any slower.</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> * So, perf isn&#39;t an issue.  Still, why not make it aggregate-initializable though?  I (ygoldfel) gave up, eventually,</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> * because I wanted *some* non-default-behavior constructors to be available, namely no-args (`Native_handle()` that</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> * makes an `null() == true` one) and move (`Native_handle(Native_handle&amp;&amp;)` that nullifies the source object).</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> * This isn&#39;t allowed in aggregate-initializable classes; so then I made some `static` &quot;constructors&quot; instead; but</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> * those aren&#39;t sufficient for containers... and on it went.  This way, though verbose, just works out better for the</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> * API.</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> */</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="structipc_1_1util_1_1Native__handle.html">   62</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>{</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"></span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment">  /// The native handle type.  Much logic relies on this type being light-weight (fast to copy).</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="structipc_1_1util_1_1Native__handle.html#a7194e8aaf9fc0109aad80222ae4ecb25">   67</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="structipc_1_1util_1_1Native__handle.html#a7194e8aaf9fc0109aad80222ae4ecb25">handle_t</a> = int;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>  <span class="comment">// Constants.</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"></span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment">   * The value for #m_native_handle such that `null() == true`; else it is `false`.</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment">   * No valid handle ever equals this.</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">   */</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="structipc_1_1util_1_1Native__handle.html#a68e693929170523d58b541d466bac03a">   75</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_typedef" href="structipc_1_1util_1_1Native__handle.html#a7194e8aaf9fc0109aad80222ae4ecb25">handle_t</a> <a class="code hl_variable" href="structipc_1_1util_1_1Native__handle.html#a68e693929170523d58b541d466bac03a">S_NULL_HANDLE</a>;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"></span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment">   * The native handle (possibly equal to #S_NULL_HANDLE), the exact payload of this Native_handle.</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment">   * It can, of course, be assigned and accessed explicitly.  The best way to initialize a</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment">   * new Native_handle is, therefore: `Native_handle{some_native_handle}`.  You may also use the</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment">   * null() &quot;constructor&quot; to create a null() handle.</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment">   */</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="structipc_1_1util_1_1Native__handle.html#ab2f496740139c5752a25a30cf3325d86">   85</a></span>  <a class="code hl_typedef" href="structipc_1_1util_1_1Native__handle.html#a7194e8aaf9fc0109aad80222ae4ecb25">handle_t</a> <a class="code hl_variable" href="structipc_1_1util_1_1Native__handle.html#ab2f496740139c5752a25a30cf3325d86">m_native_handle</a>;</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"></span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment">   * Constructs with given payload; also subsumes no-args construction to mean constructing an object with</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment">   * `null() == true`.</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment">   *</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment">   * @param native_handle</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment">   *        Payload.</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment">   */</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span>  <a class="code hl_function" href="structipc_1_1util_1_1Native__handle.html#a54a6ce76ea4ce5aa68da13d7a677ca9f">Native_handle</a>(<a class="code hl_typedef" href="structipc_1_1util_1_1Native__handle.html#a7194e8aaf9fc0109aad80222ae4ecb25">handle_t</a> native_handle = <a class="code hl_variable" href="structipc_1_1util_1_1Native__handle.html#a68e693929170523d58b541d466bac03a">S_NULL_HANDLE</a>);</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"></span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment">   * Constructs object equal to `src`, while making `src == null()`.</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment">   *</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment">   * ### Rationale ###</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment">   * This is move construction, but it&#39;s not about performance at all (as this is all quite cheap anyway);</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment">   * more to allow for the pattern of making an object from another object without propagating more copies of the</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment">   * underlying handle.  Won&#39;t the default move ctor take care of it?  No, because it&#39;ll just copy the handle and not</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment">   * nullify it.</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment">   *</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment">   *        Source object which will be made `null() == true`.</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment">   */</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span>  <a class="code hl_function" href="structipc_1_1util_1_1Native__handle.html#a54a6ce76ea4ce5aa68da13d7a677ca9f">Native_handle</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a>&amp;&amp; src);</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"></span> </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment">   * Copy constructor.</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment">   *        Source object.</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment">   */</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"><a class="line" href="structipc_1_1util_1_1Native__handle.html#a45ae7a5b093b5419a524cf30b07921c4">  117</a></span>  <a class="code hl_function" href="structipc_1_1util_1_1Native__handle.html#a45ae7a5b093b5419a524cf30b07921c4">Native_handle</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a>&amp; src);</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"></span> </div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment">   * Move assignment; acts similarly to move ctor; but no-op if `*this == src`.</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment">   *        Source object which will be made `null() == true`, unles `*this == src`.</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment">   * @return `*this`.</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment">   */</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span>  <a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a>&amp; <a class="code hl_function" href="structipc_1_1util_1_1Native__handle.html#a6e321b8cc4628d56cc903beae13c6438">operator=</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a>&amp;&amp; src);</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment"></span> </div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment">   * Copy assignment; acts similarly to copy ctor.</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment">   *        Source object.</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment">   * @return `*this`.</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment">   */</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"><a class="line" href="structipc_1_1util_1_1Native__handle.html#ad1d01d9b502f65c6fe0d8d4a1488cec4">  135</a></span>  <a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a>&amp; <a class="code hl_function" href="structipc_1_1util_1_1Native__handle.html#ad1d01d9b502f65c6fe0d8d4a1488cec4">operator=</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a>&amp; src);</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment"></span> </div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment">   * Returns `true` if and only if #m_native_handle equals #S_NULL_HANDLE.</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment">   */</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="structipc_1_1util_1_1Native__handle.html#a11bd62ce0a7bef4bdfe666201c26d4dc">null</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span>}; <span class="comment">// struct Native_handle</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span> </div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment">// Free functions.</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment"></span> </div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment">/**</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment"> * Returns `true` if and only if the two Native_handle objects are the same underlying handle.</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"> *</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment"> * @relatesalso Native_handle</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment"> *</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment"> * @param val1</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment"> *        Object.</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment"> * @param val2</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment"> *        Object.</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment"> * @return See above.</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment"> */</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="keywordtype">bool</span> <a class="code hl_function" href="namespaceipc_1_1util.html#ae4b4126f841ef060cdae15998e48691c">operator==</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a> val1, <a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a> val2);</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment"></span> </div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment">/**</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment"> * Negation of similar `==`.</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment"> *</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment"> * @relatesalso Native_handle</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment"> *</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment"> * @param val1</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment"> *        Object.</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment"> * @param val2</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment"> *        Object.</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment"> * @return See above.</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment"> */</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="keywordtype">bool</span> <a class="code hl_function" href="namespaceipc_1_1util.html#aacbd7ee43d4912a8790a228dc7cf682d">operator!=</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a> val1, <a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a> val2);</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment"></span> </div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment">/**</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment"> * Returns a less-than comparison of two Native_handle objects, with the usual total ordering guarantees.</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment"> *</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment"> * @relatesalso Native_handle</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment"> *</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment"> * @param val1</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment"> *        Left-hand side object.</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment"> * @param val2</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment"> *        Right-hand side object.</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment"> * @return Whether left side is considered strictly less-than right side.</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment"> */</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="keywordtype">bool</span> <a class="code hl_function" href="namespaceipc_1_1util.html#a6ff4b35d8fbbe2eb6266f3a7b0f07c49">operator&lt;</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a> val1, <a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a> val2);</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment"></span> </div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment">/**</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment"> * Hasher of Native_handle for boost.unordered et al.</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment"> *</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment"> * @relatesalso Native_handle</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment"> *</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment"> * @param val</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment"> *        Object to hash.</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment"> * @return See above.</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment"> */</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="keywordtype">size_t</span> <a class="code hl_function" href="namespaceipc_1_1util.html#ad3883df3081441d71a9a989073264b04">hash_value</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a> val);</div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment"></span> </div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment">/**</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="comment"> * Prints string representation of the given Native_handle to the given `ostream`.</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment"> *</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment"> * @relatesalso Native_handle</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment"> *</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment"> * @param os</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment"> *        Stream to which to write.</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment"> * @param val</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment"> *        Object to serialize.</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment"> * @return `os`.</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment"> */</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1util.html#a28030c32e9c66f5c2862cbc6998885c7">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a>&amp; val);</div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span> </div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span>} <span class="comment">// namespace ipc::util</span></div>
<div class="ttc" id="anamespaceipc_1_1util_html"><div class="ttname"><a href="namespaceipc_1_1util.html">ipc::util</a></div><div class="ttdoc">Flow-IPC module containing miscellaneous general-use facilities that ubiquitously used by ~all Flow-I...</div><div class="ttdef"><b>Definition:</b> <a href="default__init__allocator_8hpp_source.html#l00023">default_init_allocator.hpp:24</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a28030c32e9c66f5c2862cbc6998885c7"><div class="ttname"><a href="namespaceipc_1_1util.html#a28030c32e9c66f5c2862cbc6998885c7">ipc::util::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const Native_handle &amp;val)</div><div class="ttdoc">Prints string representation of the given Native_handle to the given ostream.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8cpp_source.html#l00066">native_handle.cpp:66</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a6ff4b35d8fbbe2eb6266f3a7b0f07c49"><div class="ttname"><a href="namespaceipc_1_1util.html#a6ff4b35d8fbbe2eb6266f3a7b0f07c49">ipc::util::operator&lt;</a></div><div class="ttdeci">bool operator&lt;(Native_handle val1, Native_handle val2)</div><div class="ttdoc">Returns a less-than comparison of two Native_handle objects, with the usual total ordering guarantees...</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8cpp_source.html#l00097">native_handle.cpp:97</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_aacbd7ee43d4912a8790a228dc7cf682d"><div class="ttname"><a href="namespaceipc_1_1util.html#aacbd7ee43d4912a8790a228dc7cf682d">ipc::util::operator!=</a></div><div class="ttdeci">bool operator!=(Native_handle val1, Native_handle val2)</div><div class="ttdoc">Negation of similar ==.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8cpp_source.html#l00085">native_handle.cpp:85</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ad3883df3081441d71a9a989073264b04"><div class="ttname"><a href="namespaceipc_1_1util.html#ad3883df3081441d71a9a989073264b04">ipc::util::hash_value</a></div><div class="ttdeci">size_t hash_value(Native_handle val)</div><div class="ttdoc">Hasher of Native_handle for boost.unordered et al.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8cpp_source.html#l00090">native_handle.cpp:90</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ae4b4126f841ef060cdae15998e48691c"><div class="ttname"><a href="namespaceipc_1_1util.html#ae4b4126f841ef060cdae15998e48691c">ipc::util::operator==</a></div><div class="ttdeci">bool operator==(Native_handle val1, Native_handle val2)</div><div class="ttdoc">Returns true if and only if the two Native_handle objects are the same underlying handle.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8cpp_source.html#l00080">native_handle.cpp:80</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html">ipc::util::Native_handle</a></div><div class="ttdoc">A monolayer-thin wrapper around a native handle, a/k/a descriptor a/k/a FD.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8hpp_source.html#l00062">native_handle.hpp:63</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html_a11bd62ce0a7bef4bdfe666201c26d4dc"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html#a11bd62ce0a7bef4bdfe666201c26d4dc">ipc::util::Native_handle::null</a></div><div class="ttdeci">bool null() const</div><div class="ttdoc">Returns true if and only if m_native_handle equals S_NULL_HANDLE.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8cpp_source.html#l00061">native_handle.cpp:61</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html_a45ae7a5b093b5419a524cf30b07921c4"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html#a45ae7a5b093b5419a524cf30b07921c4">ipc::util::Native_handle::Native_handle</a></div><div class="ttdeci">Native_handle(const Native_handle &amp;src)</div><div class="ttdoc">Copy constructor.</div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html_a54a6ce76ea4ce5aa68da13d7a677ca9f"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html#a54a6ce76ea4ce5aa68da13d7a677ca9f">ipc::util::Native_handle::Native_handle</a></div><div class="ttdeci">Native_handle(handle_t native_handle=S_NULL_HANDLE)</div><div class="ttdoc">Constructs with given payload; also subsumes no-args construction to mean constructing an object with...</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8cpp_source.html#l00033">native_handle.cpp:33</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html_a68e693929170523d58b541d466bac03a"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html#a68e693929170523d58b541d466bac03a">ipc::util::Native_handle::S_NULL_HANDLE</a></div><div class="ttdeci">static const handle_t S_NULL_HANDLE</div><div class="ttdoc">The value for m_native_handle such that null() == true; else it is false.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8hpp_source.html#l00075">native_handle.hpp:75</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html_a6e321b8cc4628d56cc903beae13c6438"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html#a6e321b8cc4628d56cc903beae13c6438">ipc::util::Native_handle::operator=</a></div><div class="ttdeci">Native_handle &amp; operator=(Native_handle &amp;&amp;src)</div><div class="ttdoc">Move assignment; acts similarly to move ctor; but no-op if *this == src.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8cpp_source.html#l00047">native_handle.cpp:47</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html_a7194e8aaf9fc0109aad80222ae4ecb25"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html#a7194e8aaf9fc0109aad80222ae4ecb25">ipc::util::Native_handle::handle_t</a></div><div class="ttdeci">int handle_t</div><div class="ttdoc">The native handle type. Much logic relies on this type being light-weight (fast to copy).</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8hpp_source.html#l00067">native_handle.hpp:67</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html_ab2f496740139c5752a25a30cf3325d86"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html#ab2f496740139c5752a25a30cf3325d86">ipc::util::Native_handle::m_native_handle</a></div><div class="ttdeci">handle_t m_native_handle</div><div class="ttdoc">The native handle (possibly equal to S_NULL_HANDLE), the exact payload of this Native_handle.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8hpp_source.html#l00085">native_handle.hpp:85</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html_ad1d01d9b502f65c6fe0d8d4a1488cec4"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html#ad1d01d9b502f65c6fe0d8d4a1488cec4">ipc::util::Native_handle::operator=</a></div><div class="ttdeci">Native_handle &amp; operator=(const Native_handle &amp;src)</div><div class="ttdoc">Copy assignment; acts similarly to copy ctor.</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:38 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
